Pocketbase Kotlin

Pocketbase Kotlin/io.github.agrevster.pocketbaseKotlin.services/BackupsService

BackupsService

class BackupsService(val client: PocketbaseClient) : BaseService

Constructors

constructor(client: PocketbaseClient)

Types

@Serializable

data class Backup(val key: String, val modified: String, val size: Long)

Properties

val client: PocketbaseClient

Functions

suspend fun create(name: String? = null): Boolean

Creates a new app data backup. This action will return an error if the backup to delete is still being generated or part of a restore operation.

suspend fun delete(key: String): Boolean

Deletes a single backup by name This action will return an error if the backup to delete is still being generated or part of a restore operation.

fun getBackupUrl(key: String, token: String): String

Gets the url to download a single backup file.

suspend fun getFullList(fields: ShowFields = ShowFields()): List<BackupsService.Backup>

Returns a list of all available back up files.

suspend fun restore(key: String): Boolean

Restore a single backup by its name and restarts the current running PocketBase process. This action will return an error if the backup to delete is still being generated or part of a restore operation.

suspend fun upload(file: FileUpload)